<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>wickr-crypto-c: Wickr_storage_keys</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">wickr-crypto-c
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Wickr_storage_keys</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Key's used for the client to encrypt data meant for itself, and not for other clients.  <a href="structwickr__storage__keys.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gad03ddd5ea10633ca35097e5f4707d5cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wickr__storage__keys.html#gad03ddd5ea10633ca35097e5f4707d5cb">wickr_storage_keys_create</a> (<a class="el" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *local, <a class="el" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *remote)</td></tr>
<tr class="separator:gad03ddd5ea10633ca35097e5f4707d5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gad6839a21bca1c28775d51deb6b7c3835"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wickr__storage__keys.html#gad6839a21bca1c28775d51deb6b7c3835">wickr_storage_keys_copy</a> (const <a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *source)</td></tr>
<tr class="separator:gad6839a21bca1c28775d51deb6b7c3835"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae5631d93182e635fb7f48269eb3f1723"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wickr__storage__keys.html#gae5631d93182e635fb7f48269eb3f1723">wickr_storage_keys_create_from_buffer</a> (const <a class="el" href="structwickr__buffer.html">wickr_buffer_t</a> *buffer)</td></tr>
<tr class="separator:gae5631d93182e635fb7f48269eb3f1723"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga10a0d6e13442682b2fecff2ed753c2f6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structwickr__buffer.html">wickr_buffer_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wickr__storage__keys.html#ga10a0d6e13442682b2fecff2ed753c2f6">wickr_storage_keys_serialize</a> (const <a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *keys)</td></tr>
<tr class="separator:ga10a0d6e13442682b2fecff2ed753c2f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c1494802577d025d70bf553c43da344"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__wickr__storage__keys.html#ga2c1494802577d025d70bf553c43da344">wickr_storage_keys_destroy</a> (<a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> **keys)</td></tr>
<tr class="separator:ga2c1494802577d025d70bf553c43da344"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="gad6839a21bca1c28775d51deb6b7c3835"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad6839a21bca1c28775d51deb6b7c3835">&#9670;&nbsp;</a></span>wickr_storage_keys_copy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a>* wickr_storage_keys_copy </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *&#160;</td>
          <td class="paramname"><em>source</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Copy a storage key set</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">source</td><td>the storage key set to copy </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly allocated storage key set holding a deep copy of the properties of 'source' </dd></dl>

</div>
</div>
<a id="gad03ddd5ea10633ca35097e5f4707d5cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad03ddd5ea10633ca35097e5f4707d5cb">&#9670;&nbsp;</a></span>wickr_storage_keys_create()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a>* wickr_storage_keys_create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *&#160;</td>
          <td class="paramname"><em>local</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="structwickr__cipher__key.html">wickr_cipher_key_t</a> *&#160;</td>
          <td class="paramname"><em>remote</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a storage key set from components</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">local</td><td>see '<a class="el" href="structwickr__storage__keys.html" title="Key&#39;s used for the client to encrypt data meant for itself, and not for other clients.">wickr_storage_keys</a>' property documentation </td></tr>
    <tr><td class="paramname">remote</td><td>see '<a class="el" href="structwickr__storage__keys.html" title="Key&#39;s used for the client to encrypt data meant for itself, and not for other clients.">wickr_storage_keys</a>' property documentation </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly allocated storage key set. Takes ownership of the passed inputs </dd></dl>

</div>
</div>
<a id="gae5631d93182e635fb7f48269eb3f1723"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae5631d93182e635fb7f48269eb3f1723">&#9670;&nbsp;</a></span>wickr_storage_keys_create_from_buffer()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a>* wickr_storage_keys_create_from_buffer </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structwickr__buffer.html">wickr_buffer_t</a> *&#160;</td>
          <td class="paramname"><em>buffer</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Create a storage key set from a previously serialized storage key set</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>a buffer containing the output of 'wickr_storage_keys_serialize' </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a newly allocated storage key set or NULL if parsing fails </dd></dl>

</div>
</div>
<a id="ga2c1494802577d025d70bf553c43da344"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c1494802577d025d70bf553c43da344">&#9670;&nbsp;</a></span>wickr_storage_keys_destroy()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void wickr_storage_keys_destroy </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> **&#160;</td>
          <td class="paramname"><em>keys</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Destroy a storage key set</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keys</td><td>a pointer to the storage key set to destroy. All properties of '*keys' will also be destroyed </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga10a0d6e13442682b2fecff2ed753c2f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga10a0d6e13442682b2fecff2ed753c2f6">&#9670;&nbsp;</a></span>wickr_storage_keys_serialize()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structwickr__buffer.html">wickr_buffer_t</a>* wickr_storage_keys_serialize </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="structwickr__storage__keys.html">wickr_storage_keys_t</a> *&#160;</td>
          <td class="paramname"><em>keys</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Serialize a storage key set to a buffer</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">keys</td><td>the keys to serialize </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>a buffer containing the properties of storage keys in the following format: | CIPHER_ID (LOCAL) | KEY_DATA (LOCAL) | CIPHER_ID (REMOTE) | KEY_DATA (REMOTE) | </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
